[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
SHOW_NTX()      Index "gas guage"

Description:
  SHOW_NTX() provides the programmer with a non-screen destructive "gas
  guage" type of chart to show the user what percentage of the index
  operation is complete.


Syntax:     
  SHOW_NTX( <expC1>, <expC2> )


Pass:       
  <expC1>  = Name of the NTX/NDX file to create i.e. "MYINDEX"

  <expC2>  = Index key i.e. "LAST_NAME+FRST_NAME"


Return:     
  <expL>   = .T. if successful, otherwise .F.


Notes:      
  *** IMPORTANT!! *** <ExpC2> must "evaluate" to a character value.
  i.e.  The index key must be a character value such as
  "LAST_NAME+FRST_NAME" not "AMOUNT", etc.


  Summer 87 Notes:

  Two PUBLIC variables are created that you will need to be aware of...
  gn_Records, and gn_RecPerCol.  These variables are RELEASED before
  SHOW_NTX() returns control to your calling program, but you need to be
  aware so as not to use these variable names.


Example:    
  USE CLIENT ALIAS CLIENT
  IF .NOT. FILE("CLIENT1.NTX")
     SHOW_NTX("CLIENT1","ZIP_CODE+ACCT_NMBR")
  ENDIF
  IF .NOT. FILE("CLIENT2.NTX")
     SHOW_NTX("CLIENT2","SLSPERSON")
  ENDIF
  SET INDEX TO CLIENT1, CLIENT2


Usage:      
  One of the biggest disadvantages of Clipper is the inability to show
  the progress of an index operation. While it can be argued that the
  hard drive access light is sufficient to tell the user that something
  is happening, a far greater number of users will argue to the
  contrary.  In fact, several users have been known to turn the machine
  off while in the middle of a large index operation.  SHOW_NTX()
  provides a user-friendly "gas-guage" type of display telling the user
  exactly how things are progressing.

  SHOW_NTX() is a substitution for the Clipper "INDEX ON" command.  It
  acts EXACTLY the same as "INDEX ON" in that all other index files
  currently open for the database are closed.

See Also: VWIND()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson